home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / lcall12.zip / LOGCALL.DOC < prev    next >
Encoding:
Text File  |  1992-08-01  |  7.6 KB  |  230 lines
  1.        ******************************************************************
  2.  
  3.                              LOGCALL Version 1.1
  4.                                August 1, 1992
  5.  
  6.                         MAXIMUS TODAY'S CALLER LISTER
  7.  
  8.  
  9.  
  10.  
  11.                              Code by Evan Siegworth
  12.                              
  13.                  Docs by Ed Baldwin &
  14.                                      Evan Siegworth
  15.  
  16.  
  17.  
  18.  
  19.                                  USER MANUAL
  20.  
  21.                       Copyright (c) 1992 Evan Siegworth
  22.  
  23.        *******************************************************************
  24.  
  25.  
  26.  
  27.  
  28.   THE LEGAL BUSINESS
  29.   ------------------
  30.  
  31.        LOGCALL operates as specified on the authors' and beta testers'
  32.        systems. Use it at your own risk.  No warranty is stated or
  33.        implied.  The author shall not be responsible for any damages
  34.        resulting from its' use, directly or indirectly.
  35.  
  36.        LOGCALL is distributed as a Freely Available Copyrighted Program.
  37.        You may use, copy, or lose it, but I own the rights to it.
  38.        SysOps may use any compression method acceptable to them for file
  39.        storage on their respective BBS's.  The author asks only that BBS
  40.        advertisements NOT be included in the archive or archive comments.
  41.        No fee may be charged for distribution.
  42.  
  43.        While LOGCALL is freely available for use in non-commercial
  44.        environments, donations to the author will always be gratefully
  45.        accepted.
  46.  
  47.        For information of donations, use on a commercial bbs, or info on
  48.        where to send suggestions, please read the REGIST.DOC included
  49.        in the archive.
  50.  
  51.        LOGCALL will be supported in the MUFFIN Echo, any questions will be
  52.        promptly answered.
  53.  
  54.  
  55.  
  56.  
  57.   THE DISTRIBUTION ARCHIVE (LCALL11.ZIP)
  58.   ---------------------------------------
  59.  
  60.        This archive should contain the following files:
  61.  
  62.        LOGCALL.DOC        -      The complete program documentation.
  63.        LOGCALL.EXE        -      The Executable Program.
  64.        LOGCALL.CTL        -      The Configuration File.
  65.        HISTORY.DOC        -      The program history.
  66.        README.OS2         -      Information for OS/2 Users.
  67.        REGIST.DOC         -      Donation/Registration Information.
  68.            
  69.        
  70.  
  71.   WHAT DOES IT DO
  72.   ---------------
  73.  
  74.        LOGCALL is a Maximus CBCS Today's Callers List Creation utility which
  75.        can create a list of the users whom have called today and a list of
  76.        the last few callers.  It is very configurable.  You set up how you
  77.        want the utility to display the information.
  78.        It creates .BBS files that can be directly displayed to the user.
  79.  
  80.  
  81.  
  82.   INSTALLING LOGCALL
  83.   ------------------
  84.  
  85.        1.  Edit the LOGCALL.CTL file to your systems configuration. An
  86.        explanation of this is provided in a later section.
  87.  
  88.        DONT FORGET!
  89.        2.  Compile the control file.  This is done by entering LOGCALL /U
  90.        at a DOS prompt in the directory that you have both LOGCALL.EXE and
  91.        LOGCALL.CTL located in.  This will create logcall.cfg.
  92.  
  93.        3. That's about it! Test it's functionality.
  94.  
  95.  
  96.  
  97.   CONFIGURATION FILE
  98.   ------------------
  99.  
  100. **    The Configuration File (logcall.cfg) is created by compiling
  101.     the Control file (logcall.ctl).
  102.     You compile by running LogCall with the '/u' option.
  103.     Most of the Control file is self-explanatory.
  104.     Some notes:
  105.         -When specifing filenames, paths are not needed if you want
  106.          the file to be created in the current directory.
  107.          If you want to specify a different directory, you must 
  108.          type in the FULL path including drive letter.
  109.         
  110.         -If you make a change, be sure to re-compile 
  111.  
  112.         -Each section must end with the 'End' statement.
  113.  
  114. **    The 'CustomDisplayLine' section is the most complicated section so I
  115.     am covering its explanation here.
  116.     This is also the most unique feature of this program.  YOU control
  117.     how the    program displays its information. 
  118.     
  119.     Each display line must be proceeded by its name.      
  120.     
  121.     Entering the display line is alot like entering a line in a MECCA file.
  122.     Straight text will be copied directly.  And there are several 
  123.     informational tokens that can be placed on the line, as well as
  124.     all the regular color tokens.  At this time, however, background
  125.     colors and blinking are not supported.
  126.     
  127.     For Example:
  128.     A display line like this:
  129.  
  130. User # 23 Evan Siegworth        calling from Channelview, TX
  131.         
  132.     Would be entered like this:
  133.  
  134. #TEST
  135. #User # [user] [name]  calling from [city]
  136.  
  137.     Its that simple!
  138.     You can spice it up by adding color tokens.
  139.     
  140.     To then use this in your Todays Callers List, you add the line
  141.         StatLine    TEST
  142.     to the 'TodaysCallers' section in the control file.
  143.  
  144.     The Header lines are similar, however, they do not use any of the info
  145.     tokens.  The header line is displayed at the beginning of the file.
  146.     Example Usage:
  147.     (in appropriate section)        
  148.         Header        TEST2
  149. (in CustomDisplayLine section)
  150. #TEST2
  151. #<-----------------------TODAYS CALLERS------------------------>
  152.  
  153.  
  154. **    Some important notes:
  155.     Only ONE token per bracket.  [user green name city] will NOT work.
  156.     Your display line MUST be the next line after its name header.
  157.     
  158.     Several display lines are included in the .ctl that came with
  159.     the program.  Use them or create your own.
  160.     You can use ORACLE to test your display lines.
  161.  
  162. **      AVAILABLE TOKENS:
  163.  
  164.               MAXIMUS Colour Tokens
  165.               [START] - Logon Time
  166.               [END] - Logoff Time
  167.               [DATE] - Logon Date
  168.               [NAME] - User's Real Name
  169.               [ALIAS] - User's Handle/Alias
  170.               [CITY] - User's City/State
  171.               [BAUD] - User's Baud Rate(displays LOCAL for local calls)
  172.               [TOTAL] - Total Number of Calls
  173.               [TIME] - Minutes Spent Online
  174.               [USER] - User Number(field length is 3 spaces)
  175.  
  176.  
  177.   USING LOGCALL
  178.   -------------
  179.     
  180. **    LogCall is run in your batch file that starts the bbs
  181.     with the command...
  182.  
  183.            LOGCALL %1 %2
  184.     %1 being the name/path of the Lastuser.bbs file.
  185.     %2 being the name/path of the Max log file
  186.  
  187.     For Example:
  188.        LOGCALL C:\MAX\LASTUSER.BBS C:\MAX\MAX.LOG
  189.     
  190.     You should only run it after an errorlevel 5 exit.
  191.     During its operation LogCall will check the Lastuser.bbs to see
  192.     if its newer the last time it was run.  This prevents it from
  193.     running after a dropped carrier and other situations where there
  194.     really wasnt a caller.
  195.     You can, however, disable this option with the '/t' option.
  196.        LOGCALL /T LASTUSER.BBS MAX.LOG
  197.     This is primarly useful when testing your Display Lines.
  198.  
  199. **    You should delete the today's callers list (ex: Callers.bbs)
  200.     every night.  Put it in your nightly maintance.    
  201.  
  202. **      Next add a command to your MAXIMUS MENUS.CTL file:
  203.     (using Callers.bbs from above sample .ctl file.  substitute own
  204.      name of course)
  205.  
  206.           Display_File  Misc\Callers             Twit "Todays Callers"
  207.  
  208. **      If you wish to utilize the Last Few Callers feature.
  209.     Add a [LINK] command to your WELCOME.BBS or other file that you
  210.         wish to display to the users at logon to show the last few callers.
  211.  
  212.           [LINK]C:\MAX\MISC\CALLS
  213.  
  214.   THANKS...(as of yet)
  215.   ---------
  216.     
  217.     Thanks to Scott Dudley for his excellent BBS System!
  218.     to Ed Baldwin for his help with code development, testing and DOC
  219.        writing.
  220.     to Gary Seid for his numerous bug reports!  :)
  221.     and to ALL who are patiently waiting through the bug-fix releases.
  222.  
  223.   CREDITS
  224.   -------
  225.  
  226.          BORLAND C++  ... Copyrighted by Borland International, Inc.
  227.          ORACLE &
  228.      MAXIMUS CBCS ... Copyrighted by Scott Dudley
  229.          LOGCALL      ... Copyrighted by Evan Siegworth
  230.